home *** CD-ROM | disk | FTP | other *** search
/ Aminet 48 / Aminet 48 (2002)(GTI - Schatztruhe)[!][Apr 2002].iso / Aminet / text / edit / vim60rt.lha / Vim / vim60 / doc / xxd.man < prev   
Encoding:
Text File  |  2000-11-13  |  11.5 KB  |  397 lines
  1.  
  2.  
  3.  
  4. XXD(1)                                                     XXD(1)
  5.  
  6.  
  7. NAME
  8.        xxd - make a hexdump or do the reverse.
  9.  
  10. SYNOPSIS
  11.        xxd -h[elp]
  12.        xxd [options] [infile [outfile]]
  13.        xxd -r[evert] [options] [infile [outfile]]
  14.  
  15. DESCRIPTION
  16.        xxd  creates a hex dump of a given file or standard input.
  17.        It can also convert a hex dump back to its original binary
  18.        form.   Like  uuencode(1)  and  uudecode(1)  it allows the
  19.        transmission of binary data in a `mail-safe' ASCII  repre-
  20.        sentation,  but  has the advantage of decoding to standard
  21.        output.  Moreover, it can be used to perform  binary  file
  22.        patching.
  23.  
  24. OPTIONS
  25.        If  no infile is given, standard input is read.  If infile
  26.        is specified as a `-' character, then input is taken  from
  27.        standard  input.  If no outfile is given (or a `-' charac-
  28.        ter is in its place), results are sent to standard output.
  29.  
  30.        Note that a "lazy" parser is used which does not check for
  31.        more than the first option letter, unless  the  option  is
  32.        followed  by  a parameter.  Spaces between a single option
  33.        letter and its  parameter  are  optional.   Parameters  to
  34.        options  can be specified in decimal, hexadecimal or octal
  35.        notation.  Thus -c8, -c 8, -c 010  and  -cols  8  are  all
  36.        equivalent.
  37.  
  38.  
  39.        -a | -autoskip
  40.               toggle  autoskip:  A single '*' replaces nul-lines.
  41.               Default off.
  42.  
  43.        -b | -bits
  44.               Switch to bits (binary digits)  dump,  rather  than
  45.               hexdump.  This option writes octets as eight digits
  46.               "1"s and "0"s instead of a normal hexacecimal dump.
  47.               Each line is preceded by a line number in hexadeci-
  48.               mal and followed by an ascii (or ebcdic)  represen-
  49.               tation. The command line switches -r, -p, -i do not
  50.               work with this mode.
  51.  
  52.        -c cols | -cols cols
  53.               -c cols | -cols cols format <cols> octets per line.
  54.               Default 16 (-i: 12, -ps: 30, -b: 6). Max 256.
  55.  
  56.        -E | -EBCDIC
  57.               Change the character encoding in the righthand col-
  58.               umn from ASCII to EBCDIC.  This does not change the
  59.               hexadecimal  representation. The option is meaning-
  60.               less in combinations with -r, -p or -i.
  61.  
  62.  
  63.  
  64. Manual page for xxd        August 1996                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XXD(1)                                                     XXD(1)
  71.  
  72.  
  73.        -g bytes | -groupsize bytes
  74.               seperate the output of every <bytes> bytes (two hex
  75.               characters  or  eight bit-digits each) by a whites-
  76.               pace.  Specify -g 0 to suppress grouping.   <Bytes>
  77.               defaults  to  2  in normal mode and 1 in bits mode.
  78.               Grouping does not apply to  postscript  or  include
  79.               style.
  80.  
  81.        -h | -help
  82.               print a summary of available commands and exit.  No
  83.               hex dumping is performed.
  84.  
  85.        -i | -include
  86.               output in C include file style. A  complete  static
  87.               array  definition is written (named after the input
  88.               file), unless xxd reads from stdin.
  89.  
  90.        -l len | -len len
  91.               stop after writing <len> octets.
  92.  
  93.        -p | -ps | -postscript | -plain
  94.               output in postscript continuous hexdump style. Also
  95.               known as plain hexdump style.
  96.  
  97.        -r | -revert
  98.               reverse  operation: convert (or patch) hexdump into
  99.               binary.  If not writing to stdout, xxd writes  into
  100.               its output file without truncating it. Use the com-
  101.               bination -r -p  to  read  plain  hexadecimal  dumps
  102.               without  line number information and without a par-
  103.               ticular column layout.  Additional  Whitespace  and
  104.               line-breaks are allowed anywhere.
  105.  
  106.        -seek offset
  107.               When  used after -r : revert with <offset> added to
  108.               file positions found in hexdump.
  109.  
  110.        -s [+][-]seek
  111.               start at <seek> bytes abs. (or rel.) infile offset.
  112.               +  indicates  that the seek is relative to the cur-
  113.               rent stdin  file  position  (meaningless  when  not
  114.               reading  from  stdin).   -  indicates that the seek
  115.               should be that many characters from the end of  the
  116.               input (or if combined with
  117.                +  :  before  the  current  stdin  file position).
  118.               Without -s option, xxd starts at the  current  file
  119.               position.
  120.  
  121.        -u     use  upper case hex letters. Default is lower case.
  122.  
  123.        -v | -version
  124.               show version string.
  125.  
  126.  
  127.  
  128.  
  129.  
  130. Manual page for xxd        August 1996                          2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XXD(1)                                                     XXD(1)
  137.  
  138.  
  139. CAVEATS
  140.        xxd -r has some builtin magic while evaluating line number
  141.        information.   If  the  ouput  file  is seekable, then the
  142.        linenumbers at the start of each hexdump line may  be  out
  143.        of  order,  lines may be missing, or overlapping. In these
  144.        cases xxd will lseek(2) to the next position. If the  out-
  145.        put  file  is  not  seekable, only gaps are allowed, which
  146.        will be filled by null-bytes.
  147.  
  148.        xxd -r never generates parse errors. Garbage  is  silently
  149.        skipped.
  150.  
  151.        When  editing  hexdumps,  please  note  that  xxd -r skips
  152.        everything on the input line after reading enough  columns
  153.        of hexadecimal data (see option -c). This also means, that
  154.        changes to the printable ascii  (or  ebcdic)  columns  are
  155.        always  ignored.  Reverting  a plain (or postscript) style
  156.        hexdump with xxd -r -p does not depend on the correct num-
  157.        ber  of  columns.  Here an thing that looks like a pair of
  158.        hex-digits is interpreted.
  159.  
  160.        Note the difference between
  161.        % xxd -i file
  162.        and
  163.        % xxd -i < file
  164.  
  165.        xxd -s +seek may be  different  from  xxd  -s  seek  ,  as
  166.        lseek(2) is used to "rewind" input.  A '+' makes a differ-
  167.        ence if the input source is stdin,  and  if  stdin's  file
  168.        position  is  not at the start of the file by the time xxd
  169.        is started and given its input.   The  following  examples
  170.        may help to clarify (or further confuse!)...
  171.  
  172.        Rewind  stdin before reading; needed because the `cat' has
  173.        already read to the end of stdin.
  174.        % sh -c 'cat > plain_copy; xxd -s 0 > hex_copy' < file
  175.  
  176.        Hexdump from file position 0x480 (=1024+128) onwards.  The
  177.        `+'  sign  means  "relative to the current position", thus
  178.        the `128' adds to the 1k where dd left off.
  179.        % sh -c 'dd of=plain_snippet bs=1k count=1; xxd -s +128  >
  180.        hex_snippet' < file
  181.  
  182.        Hexdump from file position 0x100 ( = 1024-768) on.
  183.        % sh -c 'dd of=plain_snippet bs=1k count=1; xxd -s +-768 >
  184.        hex_snippet' < file
  185.  
  186.        However, this is a rare situation and the use  of  `+'  is
  187.        rarely  needed.   the author prefers to monitor the effect
  188.        of xxd with strace(1) or truss(1), whenever -s is used.
  189.  
  190. EXAMPLES
  191.        Print everything but  the  first  three  lines  (hex  0x30
  192.        bytes) of file
  193.  
  194.  
  195.  
  196. Manual page for xxd        August 1996                          3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XXD(1)                                                     XXD(1)
  203.  
  204.  
  205.        % xxd -s 0x30 file
  206.  
  207.        Print 3 lines (hex 0x30 bytes) from the end of file
  208.        % xxd -s -0x30 file
  209.  
  210.        Print  120  bytes as continuous hexdump with 40 octets per
  211.        line.
  212.        % xxd -l 120 -ps -c 20 xxd.1
  213.        2e544820585844203120224d616e75616c207061
  214.        676520666f7220787864220a2e5c220a2e5c2220
  215.        32317374204d617920313939360a2e5c22204d61
  216.        6e207061676520617574686f723a0a2e5c222020
  217.        2020546f6e79204e7567656e74203c746f6e7940
  218.        7363746e7567656e2e7070702e67752e6564752e
  219.  
  220.        Hexdump the first 120 bytes  of  this  man  page  with  12
  221.        octets per line.
  222.        % xxd -l 120 -c 12 xxd.1
  223.        0000000: 2e54 4820 5858 4420 3120 224d  .TH XXD 1 "M
  224.        000000c: 616e 7561 6c20 7061 6765 2066  anual page f
  225.        0000018: 6f72 2078 7864 220a 2e5c 220a  or xxd"..\".
  226.        0000024: 2e5c 2220 3231 7374 204d 6179  .\" 21st May
  227.        0000030: 2031 3939 360a 2e5c 2220 4d61   1996..\" Ma
  228.        000003c: 6e20 7061 6765 2061 7574 686f  n page autho
  229.        0000048: 723a 0a2e 5c22 2020 2020 546f  r:..\"    To
  230.        0000054: 6e79 204e 7567 656e 7420 3c74  ny Nugent <t
  231.        0000060: 6f6e 7940 7363 746e 7567 656e  ony@sctnugen
  232.        000006c: 2e70 7070 2e67 752e 6564 752e  .ppp.gu.edu.
  233.  
  234.        Display just the date from the file xxd.1
  235.        % xxd -s 0x28 -l 12 -c 12 xxd.1
  236.        0000028: 3231 7374 204d 6179 2031 3939  21st May 199
  237.  
  238.        Copy  input_file  to  output_file and prepend 100 bytes of
  239.        value 0x00.
  240.        % xxd input_file | xxd -r -s 100 > output_file
  241.  
  242.        Patch the date in the file xxd.1
  243.        % echo '0000029: 3574 68' | xxd -r - xxd.1
  244.        % xxd -s 0x28 -l 12 -c 12 xxd.1
  245.        0000028: 3235 7468 204d 6179 2031 3939  25th May 199
  246.  
  247.        Create a 65537 byte file with all bytes 0x00,  except  for
  248.        the last one which is 'A' (hex 0x41).
  249.        % echo '010000: 41' | xxd -r > file
  250.  
  251.        Hexdump this file with autoskip.
  252.        % xxd -a -c 12 file
  253.        0000000: 0000 0000 0000 0000 0000 0000  ............
  254.        *
  255.        000fffc: 0000 0000 40                   ....A
  256.  
  257.        Create  a  1  byte file containing a single 'A' character.
  258.        The number after '-r -s' adds to the linenumbers found  in
  259.  
  260.  
  261.  
  262. Manual page for xxd        August 1996                          4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. XXD(1)                                                     XXD(1)
  269.  
  270.  
  271.        the file; in effect, the leading bytes are suppressed.
  272.        % echo '010000: 41' | xxd -r -s -0x10000 > file
  273.  
  274.        Use  xxd  as  a  filter within an editor such as vim(1) to
  275.        hexdump a region marked between `a' and `z'.
  276.        :'a,'z!xxd
  277.  
  278.        Use xxd as a filter within an editor  such  as  vim(1)  to
  279.        recover a binary hexdump marked between `a' and `z'.
  280.        :'a,'z!xxd -r
  281.  
  282.        Use  xxd  as  a  filter within an editor such as vim(1) to
  283.        recover one line of a hexdump.  Move the cursor  over  the
  284.        line and type:
  285.        !!xxd -r
  286.  
  287.        Read single characters from a serial line
  288.        % xxd -c1 < /dev/term/b &
  289.        % stty < /dev/term/b -echo -opost -isig -icanon min 1
  290.        % echo -n foo > /dev/term/b
  291.  
  292.  
  293. RETURN VALUES
  294.        The following error values are returned:
  295.  
  296.        0      no errors encountered.
  297.  
  298.        -1     operation  not supported ( xxd -r -i still impossi-
  299.               ble).
  300.  
  301.        1      error while parsing options.
  302.  
  303.        2      problems with input file.
  304.  
  305.        3      problems with output file.
  306.  
  307.        4,5    desired seek position is unreachable.
  308.  
  309. SEE ALSO
  310.        uuencode(1), uudecode(1), patch(1)
  311.  
  312. WARNINGS
  313.        The tools  weirdness  matches  its  creators  brain.   Use
  314.        entirely  at your own risk. Copy files. Trace it. Become a
  315.        wizard.
  316.  
  317. VERSION
  318.        This manual page documents xxd version 1.7
  319.  
  320. AUTHOR
  321.        (c) 1990-1997 by Juergen Weigert
  322.        <jnweiger@informatik.uni-erlangen.de>
  323.  
  324.        Distribute freely and credit me,
  325.  
  326.  
  327.  
  328. Manual page for xxd        August 1996                          5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. XXD(1)                                                     XXD(1)
  335.  
  336.  
  337.        make money and share with me,
  338.        lose money and don't ask me.
  339.  
  340.        Manual page started by Tony Nugent
  341.        <tony@sctnugen.ppp.gu.edu.au> <T.Nugent@sct.gu.edu.au>
  342.        Small  changes  by  Bram  Moolenaar.   Edited  by  Juergen
  343.        Weigert.
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394. Manual page for xxd        August 1996                          6
  395.  
  396.  
  397.